Skip to content

fix(form): a wizard with allowSkip no longer submits past the fields you skipped - #3030

Merged
os-zhuang merged 1 commit into
mainfrom
claude/wizard-skip-validation
Jul 30, 2026
Merged

fix(form): a wizard with allowSkip no longer submits past the fields you skipped#3030
os-zhuang merged 1 commit into
mainfrom
claude/wizard-skip-validation

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Two WizardForm items in one PR, as they touch the same file: the verified allowSkip validation hole, and the view-level columns gap left out of #3018.

1. allowSkip let required fields through unvalidated

handleStepClick (WizardForm.tsx:397) jumps to any step under allowSkip without validating anything on the way. A wizard mounts one step at a time, and react-hook-form only validates the fields currently mounted — so a required field on a step nobody opened was never registered, never validated, and simply absent from the payload.

Measured against the unfixed component (3 steps, required owner on step 2, allowSkip: true, click step 3's indicator, fill it, hit Create):

createCalls: 1
payload:     { subject: 'S1', notes: 'S3' }   // `owner` missing entirely
UI mentions "required": false                 // nothing said so

An invalid create went out and the client said nothing about why — #2959's validation half, wearing a wizard's clothes. This was the hypothesis I flagged as unverified two PRs ago; it reproduces.

Fix. The final submit checks the whole declared field set. When something is outstanding it returns the user to the first step holding one, marks that step's indicator (data-error="true", destructive circle + icon), names the fields in a toast, and sends nothing.

Conditional rules are honoured: the check runs on the canonical resolveFieldRuleState from @object-ui/core — the same engine the form renderer and the server's rule-validator use — so a field hidden by visibleWhen or not yet required by requiredWhen is not demanded. No second dialect.

The sequential path is unaffected: a forward jump is refused without allowSkip (verified: forwardJumpRefused: true, indicatorDisabled: true), so Next already validated each step on the way.

2. FormView.columns in the wizard

The spec key was being dropped, same as in Tabbed/Split before #3018. Grid width is now the view's columns, else the step's own. No widest-section fallback here, unlike the tabbed/split hosts: wizard steps never share a viewport, so there is no shared grid to size and each step keeps its authored width. That difference is documented.

A bug the browser caught that the test hadn't

While verifying, a step declaring columns: 2 still rendered single-column. The step grid is sized with container queries, and WizardForm's root carried no @container — so every @md:/@2xl: variant was inert. TabbedForm and SplitForm both have the wrapper; the wizard never did.

My unit test had asserted only that the grid class was present, which it always was. The test now also asserts the grid has an @container ancestor — the precondition that was actually missing.

Tests

packages/plugin-form/src/wizardSkipValidation.test.tsx — 6 cases, run against the unfixed component first: 3 failed, 3 passed, exactly as intended.

case on main
refuses the submit, returns to the offending step expected null to be truthy — no bounce, it submitted
submits once the skipped step is filled, clears the marker ❌ same defect
honours the view's columns expected null not to be null
leaves a conditionally-required field alone while its predicate is false ✅ guard
the sequential wizard still submits (gate is not a new blocker) ✅ guard
falls back to the step's own columns ✅ guard

The three failures are the defect proofs; the three passes are regression guards against my own change. 39 files / 300 tests green across plugin-form + the form renderer; turbo type-check green; lint 0 errors.

Browser verification

Zero-backend harness (deleted before commit), allowSkip + columns: 2 + two required fields on the middle step:

  • filled step 1 → jumped straight to step 3 → filled it → Create;
  • submit refused, back on Step 2 of 3, only that indicator red with the alert icon, toast reading Please complete the required fields: Owner, Team, and window.__lastCreate === null — nothing sent;
  • filled Owner + Team → Next → step 2's marker cleared to the completed tick, Notes kept its value;
  • Create{subject, notes, owner, team} — all three steps' values;
  • no console errors; columns: 2 renders 2-up after the @container fix.

Note: the toast joins field names with , rather than the the sibling implementation in form.tsx uses — this is a new English string and rule #-1 wants English punctuation. I did not touch form.tsx.

🤖 Generated with Claude Code

…s you skipped

`allowSkip` let the user jump to any step from the indicator, and handleStepClick
did so without validating anything on the way. Since a wizard mounts ONE step at
a time and react-hook-form only validates the fields currently MOUNTED, a
required field on a step nobody opened was never registered, never validated, and
simply absent from the payload.

Measured against the unfixed component — 3 steps, required `owner` on step 2,
allowSkip, click step 3's indicator, fill it, hit Create:

    createCalls: 1
    payload:     { subject: 'S1', notes: 'S3' }   // `owner` missing entirely
    UI mentions "required": false                 // nothing said so

An invalid create went out and the client said nothing about why — #2959's
validation half, wearing a wizard's clothes.

The final submit now checks the WHOLE declared field set: when something is
outstanding it returns the user to the first step holding one, marks that step's
indicator (data-error, destructive circle + icon), names the fields in a toast,
and sends nothing. Conditional rules are honoured — the check runs on the
canonical resolveFieldRuleState, the same engine the form renderer and the
server's rule-validator use, so a field hidden by visibleWhen or not yet required
by requiredWhen is not demanded. The sequential path is unaffected: a forward jump
is refused without allowSkip, so Next already validated each step on the way.

Also in WizardForm:

- FormView.columns is now honoured (spec key, previously dropped) — grid width is
  the view's `columns`, else the step's own. No widest-section fallback, unlike
  the tabbed/split hosts: wizard steps never share a viewport, so each keeps its
  authored width.
- the root gained `@container`. The step grid is sized with container queries, so
  without a container ancestor every @md:/@2XL: variant was inert and a step
  declaring 2 columns rendered single-column. Found by running it in a browser —
  the class was present all along, which is why asserting the class alone had
  missed it; the test now also asserts the container ancestor.

Browser-verified end to end (zero-backend harness): skip -> submit refused, back
on the offending step with only that indicator marked and the two field names in
the toast, no request sent; fill it -> marker clears and the create carries all
three steps' values.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 30, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectui Ignored Ignored Jul 30, 2026 11:39am

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation plugin tests labels Jul 30, 2026
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Main entry (gzip) 27.9 KB 350 KB
Entry file index-TP4jMFQr.js
Status PASS

📦 Bundle Size Report

Package Size Gzipped
app-shell (index.js) 8.20KB 2.97KB
app-shell (runtime-config.js) 7.42KB 2.32KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 7.57KB 2.97KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 1.17KB 0.53KB
auth (AuthProvider.js) 22.10KB 4.37KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.12KB 3.41KB
auth (LoginForm.js) 17.86KB 5.29KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.43KB 2.09KB
auth (SocialSignInButtons.js) 9.60KB 3.89KB
auth (UserMenu.js) 3.40KB 1.22KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 35.76KB 9.11KB
auth (createAuthenticatedFetch.js) 4.37KB 1.69KB
auth (index.js) 2.25KB 1.01KB
auth (org-roles.js) 6.72KB 2.85KB
auth (phone-identifier.js) 1.11KB 0.66KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 4.91KB 0.87KB
auth (useIsWorkspaceAdmin.js) 1.61KB 0.85KB
collaboration (CommentThread.js) 18.38KB 4.49KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 3.65KB 1.42KB
collaboration (PresenceProvider.js) 2.79KB 1.13KB
collaboration (index.js) 1.25KB 0.53KB
collaboration (useCommentSearch.js) 1.98KB 0.88KB
collaboration (useConflictResolution.js) 7.75KB 1.86KB
collaboration (useMentionNotifications.js) 1.81KB 0.68KB
collaboration (usePresence.js) 6.33KB 1.84KB
collaboration (useRealtimeSubscription.js) 7.91KB 2.01KB
components (index.js) 458.27KB 100.20KB
core (index.js) 2.16KB 0.78KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 134.67KB 34.24KB
fields (index.js) 222.07KB 54.35KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (currency.js) 1.22KB 0.64KB
i18n (i18n.js) 4.32KB 1.77KB
i18n (index.js) 2.46KB 0.96KB
i18n (pickLocalized.js) 1.70KB 0.83KB
i18n (provider.js) 5.37KB 1.72KB
i18n (useObjectLabel.js) 25.17KB 5.80KB
i18n (useSafeTranslation.js) 3.26KB 1.44KB
layout (index.js) 38.45KB 10.67KB
mobile (MobileProvider.js) 0.92KB 0.49KB
mobile (ResponsiveContainer.js) 0.94KB 0.38KB
mobile (breakpoints.js) 1.51KB 0.70KB
mobile (createOfflineDataSource.js) 5.61KB 1.74KB
mobile (index.js) 1.50KB 0.62KB
mobile (offlineQueue.js) 3.91KB 1.35KB
mobile (pwa.js) 0.97KB 0.49KB
mobile (serviceWorker.js) 1.48KB 0.62KB
mobile (serviceWorkerSource.js) 3.41KB 1.48KB
mobile (useBreakpoint.js) 1.54KB 0.65KB
mobile (useGesture.js) 6.96KB 1.98KB
mobile (useOfflineSync.js) 1.99KB 0.72KB
mobile (usePullToRefresh.js) 2.53KB 0.85KB
mobile (useResponsive.js) 0.71KB 0.42KB
mobile (useResponsiveConfig.js) 1.36KB 0.63KB
mobile (useSpecGesture.js) 4.05KB 1.53KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 6.84KB 2.42KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 3.67KB 1.12KB
permissions (evaluator.js) 4.41KB 1.44KB
permissions (index.js) 0.91KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.52KB
permissions (usePermissions.js) 1.55KB 0.71KB
plugin-ai (index.js) 15.71KB 3.79KB
plugin-calendar (index.js) 44.90KB 12.35KB
plugin-charts (index.js) 60.52KB 17.11KB
plugin-chatbot (index.js) 180.09KB 42.72KB
plugin-dashboard (index.js) 111.59KB 28.74KB
plugin-designer (index.js) 210.56KB 42.56KB
plugin-detail (index.js) 221.50KB 54.15KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 106.35KB 25.82KB
plugin-gantt (index.js) 162.26KB 39.53KB
plugin-grid (index.js) 180.86KB 47.45KB
plugin-kanban (index.js) 47.82KB 13.18KB
plugin-list (index.js) 102.39KB 24.18KB
plugin-map (index.js) 16.80KB 5.24KB
plugin-markdown (index.js) 13.65KB 4.67KB
plugin-report (index.js) 40.32KB 10.53KB
plugin-timeline (index.js) 25.75KB 7.32KB
plugin-tree (index.js) 8.36KB 2.81KB
plugin-view (index.js) 85.91KB 20.99KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.90KB 0.85KB
providers (UploadProvider.js) 11.71KB 3.53KB
providers (index.js) 0.44KB 0.22KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 5.67KB 2.37KB
react (LazyPluginLoader.js) 3.77KB 1.33KB
react (SchemaRenderer.js) 19.28KB 6.38KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 1.02KB 0.55KB
sdui-parser (codegen.js) 4.09KB 1.74KB
sdui-parser (index.js) 3.47KB 1.54KB
sdui-parser (parse.js) 10.04KB 2.82KB
sdui-parser (types.js) 0.29KB 0.24KB
sdui-parser (validate.js) 4.69KB 1.48KB
types (ai.js) 0.20KB 0.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 2.87KB 0.99KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (complex.js) 0.20KB 0.18KB
types (crud.js) 0.20KB 0.18KB
types (data-display.js) 0.20KB 0.18KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 0.77KB 0.41KB
types (disclosure.js) 0.20KB 0.18KB
types (error-code.js) 1.54KB 0.88KB
types (feedback.js) 0.20KB 0.18KB
types (field-types.js) 0.20KB 0.18KB
types (form.js) 0.20KB 0.18KB
types (index.js) 2.00KB 0.96KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 0.20KB 0.18KB
types (navigation.js) 0.20KB 0.18KB
types (objectql.js) 0.20KB 0.18KB
types (overlay.js) 0.20KB 0.18KB
types (permissions.js) 0.20KB 0.18KB
types (plugin-scope.js) 0.20KB 0.18KB
types (record-components.js) 0.20KB 0.19KB
types (record-semantics.js) 1.28KB 0.67KB
types (registry.js) 0.20KB 0.18KB
types (reports.js) 0.20KB 0.18KB
types (spec-report.js) 5.04KB 1.93KB
types (system-fields.js) 2.39KB 1.17KB
types (theme.js) 0.20KB 0.18KB
types (ui-action.js) 1.08KB 0.64KB
types (views.js) 0.20KB 0.18KB
types (widget.js) 0.20KB 0.18KB

Size Limits

  • ✅ Core packages should be < 50KB gzipped
  • ✅ Component packages should be < 100KB gzipped
  • ⚠️ Plugin packages should be < 150KB gzipped

@os-zhuang
os-zhuang merged commit c0d0bc8 into main Jul 30, 2026
16 checks passed
@os-zhuang
os-zhuang deleted the claude/wizard-skip-validation branch July 30, 2026 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation plugin tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant